Skip to main content

Remove User from Team

This endpoint removes a member from a specified team. It uses the HTTP DELETE method and requires authentication via an API key and email id.

API Endpoint​

api/v3/provisioning/user-team/team/{teamId}/{memberId}?apikey=<API_KEY>&email=<EMAIL>

Request Syntax​

DELETE /api/v3/provisioning/user-team/team/{teamId}/{memberId}?apikey=<API_KEY>&email=<EMAIL>
  • Method: DELETE
  • Content-Type:
    • application/x-www-form-urlencoded (form-data)

Request Parameters​

  • Parameters:
    • email: Caller’s EMAIL
    • apikey: API KEY
  • Path Parameter:
    • teamId: The ID of the team to provision into
    • memberId: The ID of the user/member to be removed

Properties​

NameTypeRequiredDescription
teamIdstringYesThe ID of the team
memberIdstringYesThe ID of the user/member to be removed

Example​

Sample Request​

curl --location --globoff --request DELETE \
'https://alb-backend.msgkart.com/api/v3/provisioning/user-team/team/{{teamId}}/{{memberId}}?apikey=<API KEY>&email=<EMAIL ID>'

Response​

  • HTTP Status Code: 200 OK (successful), 4xx/5xx (error)
  • Response Body: JSON object containing user status details.

Error Handling​

  • Invalid credentials: 401 Unauthorized
  • Missing/invalid parameters: 400 Bad Request
  • Internal server error: 500 Internal Server Error